FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.genomics-reporting#current (47 ms)

Package hl7.fhir.uv.genomics-reporting
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/genomics-reporting/https://build.fhir.org/ig/HL7/genomics-reporting/OperationDefinition-find-population-molecular-consequences.html
Url http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-population-molecular-consequences
Version 3.0.0
Status active
Date 2024-12-12T20:13:16+00:00
Name FindPopulationMolecularConsequences
Title Find Population Molecular Consequences
Experimental False
Realm uv
Authority hl7
Description Retrieve count or list of patients having molecular consequences.
Type true
Kind operation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition find-population-molecular-consequences

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INvariants0..*string
(string)

List of variants from which implications are derived. Must be in HGVS or SPDI format.

INfeatureConsequences0..*string
(token)

List of consequences sought. Must be in token or codesystem|code format. (These will generally be coded with Sequence Ontology codes under SO:0001537)

INgenomicSourceClass0..1string
(token)

Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class.

INincludePatientList0..1boolean

Include list of matching patients if set to true. Default=false.

OUTconsequences1..1
OUTconsequences.numerator1..1Quantity

Count of patients meeting criteria

OUTconsequences.denominator0..1Quantity

Count of patients in the cohort searched

OUTconsequences.subject0..*string

Patient ID. Include if includePatientList=true


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "find-population-molecular-consequences",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition find-population-molecular-consequences</b></p><a name=\"find-population-molecular-consequences\"> </a><a name=\"hcfind-population-molecular-consequences\"> </a><a name=\"find-population-molecular-consequences-en-US\"> </a><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>variants</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>List of variants from which implications are derived. Must be in HGVS or SPDI format.</p>\n</div></td></tr><tr><td>IN</td><td>featureConsequences</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>List of consequences sought. Must be in token or codesystem|code format. (These will generally be coded with Sequence Ontology codes under SO:0001537)</p>\n</div></td></tr><tr><td>IN</td><td>genomicSourceClass</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td><div><p>Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class.</p>\n</div></td></tr><tr><td>IN</td><td>includePatientList</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Include list of matching patients if set to true. Default=false.</p>\n</div></td></tr><tr><td>OUT</td><td>consequences</td><td/><td>1..1</td><td></td><td/><td/></tr><tr><td>OUT</td><td>consequences.numerator</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Quantity\">Quantity</a></td><td/><td><div><p>Count of patients meeting criteria</p>\n</div></td></tr><tr><td>OUT</td><td>consequences.denominator</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Quantity\">Quantity</a></td><td/><td><div><p>Count of patients in the cohort searched</p>\n</div></td></tr><tr><td>OUT</td><td>consequences.subject</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Patient ID. Include if includePatientList=true</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cg"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/genomics-reporting/OperationDefinition/find-population-molecular-consequences",
  "version" : "3.0.0",
  "name" : "FindPopulationMolecularConsequences",
  "title" : "Find Population Molecular Consequences",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-12T20:13:16+00:00",
  "publisher" : "HL7 International / Clinical Genomics",
  "contact" : [
    {
      "name" : "HL7 International / Clinical Genomics",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/clingenomics"
        },
        {
          "system" : "email",
          "value" : "cg@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "Retrieve count or list of patients having molecular consequences.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "match",
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "variants",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of variants from which implications are derived. Must be in HGVS or SPDI format.",
      "type" : "string",
      "searchType" : "string"
    },
    {
      "name" : "featureConsequences",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "List of consequences sought. Must be in token or codesystem|code format. (These will generally be coded with Sequence Ontology codes under SO:0001537)",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "genomicSourceClass",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Enables an App to limit results to those that are 'germline' or 'somatic'. Default is to include variants irrespective of genomic source class.",
      "type" : "string",
      "searchType" : "token"
    },
    {
      "name" : "includePatientList",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Include list of matching patients if set to true. Default=false.",
      "type" : "boolean"
    },
    {
      "name" : "consequences",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "part" : [
        {
          "name" : "numerator",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "Count of patients meeting criteria",
          "type" : "Quantity"
        },
        {
          "name" : "denominator",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Count of patients in the cohort searched",
          "type" : "Quantity"
        },
        {
          "name" : "subject",
          "use" : "out",
          "min" : 0,
          "max" : "*",
          "documentation" : "Patient ID. Include if includePatientList=true",
          "type" : "string"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.